docs: add PLAYGROUND.md hands-on guide#12
Merged
Merged
Conversation
A step-by-step guide for experimenting with the pipeline in a Codespace: edit the example input, re-run the pipeline, poke the CLI/REPL. Includes a section on switching to the real schema in private/ and the pipeline caveat. Co-Authored-By: Claude Opus 4.8 <[email protected]>
|
IanMayo
pushed a commit
that referenced
this pull request
Jun 20, 2026
…ivate-schema path Fold in the hands-on bits from the PLAYGROUND.md proposal (#12): - Adventure 1: edit examples/calculation_input.xml and re-run; break it on purpose to watch the gate reject invalid input with no stale artifact. - Adventure 2: show serialize.to_xml in the REPL. - Adventure 5 (new): point the CLI at the gitignored private/ real schema via generate/validate/compare, with the caveat that full pipeline imports the committed models. Co-Authored-By: Claude Opus 4.8 <[email protected]> Claude-Session: https://claude.ai/code/session_01AHAkhfmfcCdWTHZuvRcJNF
Contributor
Author
|
Closing this in favour of #16, which folded this guide's unique hands-on material directly into the README's "Self-guided adventures":
Keeping the adventures in one place (the README) avoids the docs drifting between two files. Thanks for the proposal — it's what surfaced these gaps. Generated by Claude Code |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
PLAYGROUND.md— a hands-on guide for experimenting with the pipeline in a Codespace.make pipeline→ editexamples/calculation_input.xml→ break it on purpose → poke theacousticCLI → explore in a Python REPL.private/workflow, why real-generated models go toprivate/models/(drift gate + leak risk), and thegenerate/validate/comparecommands againstprivate/paths.acoustic pipelineimports the committedacoustic_dataset.models, so running the full pipeline on real models needs a deliberate, reviewed change.Placed at the repo root (not under
docs/) so it doesn't affect the strict MkDocs build.🤖 Generated with Claude Code